Add some explanatory comments to gir config
authorFelix Krull <f_krull@gmx.de>
Sat, 18 May 2019 15:26:30 +0000 (17:26 +0200)
committerColin Walters <walters@verbum.org>
Fri, 6 May 2022 16:53:53 +0000 (12:53 -0400)
rust-bindings/rust/conf/ostree.toml

index b7c0347b9b378db7722d7844e919dbe56e8ea078..7e50b71f2600722c09dfa9d05ec42c138781f207 100644 (file)
@@ -56,13 +56,14 @@ manual = [
 [[object]]
 name = "OSTree.CollectionRef"
 status = "manual"
+    # for reference: the settings used to generate the hand-tuned implementation
     [[object.function]]
     # helper functions for NULL-terminated arrays
     pattern = "dupv|freev"
     ignore = true
 
     [[object.function]]
-    # we get this for free?
+    # we get this for free, I think?
     name = "dup"
     ignore = true
 
@@ -75,7 +76,7 @@ status = "generate"
     ignore = true
 
     [[object.function]]
-    # async generates bad code for now; revisit with newer gir
+    # async generates bad code (for now?); revisit with newer gir
     pattern = ".+_async"
     ignore = true
 
@@ -83,9 +84,11 @@ status = "generate"
 name = "OSTree.*"
 status = "generate"
     [[object.function]]
+    # both too low-level to be generated safely
     pattern = "cmp_checksum_bytes|checksum_inplace_to_bytes"
     ignore = true
 
     [[object.constant]]
+    # version-dependent constants
     pattern = "VERSION|VERSION_S|YEAR_VERSION|RELEASE_VERSION"
     ignore = true